Node / markqvist / pycodec2.git / files / DEV.md

Displaying Rendered • View raw • Download

This file is meant for developers. It provides instructions on how to

work with the repository.

This section explains how to setup your development environment upon cloning

this repository.

1. Run

T282828

This section explains how to build

a wheel of this package on your local

machine.

1. Run

T282828

This builds a wheel file and saves it in T383838dist/.

A version release consists of producing the following artifacts:

1. Tagging a commit with a version string (T383838vx.y.z).

2. Uploading the package's wheels and an sdist archive to:

1. PyPI

2. GitHub Releases

To create a release, run the following steps:

1. Run T383838dev/bin/release-new-version-tag

2. Run the build GitHub action.

3. Fetch the built artifacts and unpack.

4. Run T383838twine upload pycodec2-$VERSION*.

5. Run T383838gh release create v$VERSION pycodec2-$VERSION*.

This project uses Pipenv to simplify managing development environment

dependencies. It does not use Poetry, because Poetry does not support building

impure Python wheels (those with Cython), so it would be quite surprising to

have Poetry AND use setuptools directly to build this package.